@ctiVideo 1.3 Programmers Library
| Properties | |
| AbortLeftMouse Boolean |
Returns or sets abort flag for
left mouse button. If this member is TRUE, streaming capture stops if the left mouse
button is pressed. TRUE - capture stops |
| AbortRightMouse Boolean |
Returns or sets abort flag for
left mouse button. If this member is TRUE, streaming capture stops if the left mouse
button is pressed. TRUE - capture stops |
| AVIFile String |
Returns or sets the
fully-qualified filename (path + name), used for capturing of motion video. Used by the
CaptureAVI method. Default value: C:\CAPTURE.AVI |
| BackColor Long |
Returns or sets the background color of the object. |
| BMPFile String |
Returns or sets the fully-qualified filename (path + name), used for capturing of single frames. Used by the CaptureFrame method. |
| BorderStyle Integer |
Returns or sets the border
style of the object. None - 0 (Default) |
| btnCompressionVisible Boolean |
Returns or sets a value
indicating whether the compression button is visible or hidden. TRUE - Visible
(Default) |
| btnDisplayVisible Boolean |
Returns or sets a value
indicating whether the display button is visible or hidden. TRUE - Visible
(Default) |
| btnFormatVisible Boolean |
Returns or sets a value
indicating whether the format button is visible or hidden. TRUE - Visible
(Default) |
| btnOverlayVisible Boolean |
Returns or sets a value
indicating whether the overlay button is visible or hidden. TRUE - Visible
(Default) |
| btnPreviewVisible Boolean |
Returns or sets a value
indicating whether the preview button is visible or hidden. TRUE - Visible
(Default) |
| btnSourceVisible Boolean |
Returns or sets a value
indicating whether the source button is visible or hidden. TRUE - Visible
(Default) |
| CaptureAudio Boolean |
Returns or sets capture audio
flag. If this member is TRUE, audio is captured during streaming capture. This is the
default value if audio hardware is installed. TRUE - Capture the audio stream |
| DisplayMode Integer |
Returns or sets the current
display mode of the control. The property can have one of the following values: NoDisplay: In this mode @ctiVideo doesn't show the live video on the screen. Overlay: In this mode @ctiVideo uses the frame grabber overlay module to display real-time video. This unload the central processor and speeds up other program activities. This option is not available for frame grabber boards without overlay capabilities. The DriverHasOverlay property contains information about the overlay capabilities of the driver. Preview: In this mode @ctiVideo uses software methods to grab single frames and display them on the screen. This can cause excessive overload of the central processor and slow down other program activities. This option is available for all frame grabber boards. |
| DriverCount Integer NEW in Ver. 1.2 |
Returns the number of registered Video capture devices. If 0, the system doesn't have a Video-for-Windows compatible capture device installed. You can use this property to determine if there is any hardware, capable of capturing video on the executing system. |
| DriverHasDlgVideoDisplay Boolean |
Returns Video display dialog
flag. The value of this member is TRUE if the device supports a dialog box for controlling
the redisplay of video from the capture frame buffer. TRUE - Driver supports the
dialog |
| DriverHasDlgVideoFormat Boolean |
Returns Video format dialog
flag. The value of this member is TRUE if the device supports a dialog box for selecting
the video format. TRUE - Driver supports the dialog |
| DriverHasDlgVideoSource Boolean |
Returns Video source dialog
flag. The value of this member is TRUE if the device supports a dialog box for selecting
and controlling the video source. TRUE - Driver supports the dialog |
| DriverHasOverlay Boolean |
Returns Video-overlay flag.
The value of this member is TRUE if the device supports video overlay. TRUE -
Driver supports overlay |
| DriverName (DriverIndex) String NEW in Ver. 1.2 |
Returns the name of the capture driver, pointed by DriverIndex parameter. DriverIndex can be between 0 and (DriverCount -1). If DriverCount is 0, or if DriverIndex is bigger than (DriverCount -1), the property will return empty string. |
| DriverName (DriverIndex) String NEW in Ver. 1.2 |
Returns the version of the capture driver, pointed by DriverIndex parameter. DriverIndex can be between 0 and (DriverCount -1). If DriverCount is 0, or if DriverIndex is bigger than (DriverCount -1), the property will return empty string. |
| HitOKToCapture Boolean |
Returns or sets user-initiated
capture flag. If this member is TRUE, @ctiVideo displays a dialog box prompting the user
to initiate capture. Default value: FALSE |
| LimitEnabled Boolean |
Returns or sets time limit
enabled flag. If this member is TRUE, streaming capture stops after the number of seconds
in TimeLimit property has elapsed. Default value: FALSE |
| MicroSecPerFrame Long |
Returns or sets requested
frame rate, in microseconds. The default value is 66667, which corresponds to 15 frames
per second. Default value: 66667 |
| TimeLimit Long |
Returns or sets time limit for capture, in seconds. This parameter is used only if LimitEnabled property is TRUE |
| ToolbarAlignment Integer |
Returns or sets a value that
determines whether the control toolbar is displayed at the top or bottom of the control. tbTop
- 0 (Default) |
| ToolbarBorder Integer |
Returns or sets the border
style of the @ctiVideo control toolbar. None - 0 (Default) |
| ToolbarPosition Integer |
Returns or sets a value that
determines whether the @ctiVideo control toolbar buttons are aligned to the left, right or
center of the toolbar. tbLeft - 0 (Default) |
| ToolbarVisible Boolean |
Returns or sets a value
indicating whether the @ctiVideo control toolbar is visible or hidden. TRUE -
Visible (Default) |
| VideoConnected Boolean |
Returns the current status of the @ctiVideo control. If TRUE, the control is connected to the frame grabber device driver. If FALSE, the control is not connected and no capture activities can be performed. The value of the property is affected by the ConnectVideo and DisconnectVideo methods. |
| Methods | |
| About [Void] |
Displays an About dialog box that contains the version number of the control. |
| CaptureAVI Boolean |
Starts capturing motion video
to the filename, specified in the AVIFile property. The format and duration of the
captured video clip depend on the values of the rest of the properties. The method will
stop recording and return control to the calling procedure after the user presses [Esc]
button, left or right mouse button (depending on the values of the AbortLeftMouse
and AbortRightMouse properties) or after the time, specified in TimeLimit
property elapses (depending on the value of LimitEnabled property) TRUE
- capture successful |
| CaptureFrame (FileFormat,
FileQuality) Boolean CHANGED in Ver. 1.2 |
Captures a single frame and
saves it to the filename, specified in the BMPFile property. The format
of the captured frame (size and color depth) depends on the values of the rest of the
properties. The format of the captured file depends on the parameters: FileFormat
(Optional) - if ffBMP, saves the frame into a Windows BMP file; if ffJPEG, saves the
frame into a JPEG file with quality factor specified in FileQuality parameter. If
omited, defaults to ffBMP. TRUE - capture successful |
| ClipboardCopy Boolean NEW in Ver. 1.2 |
Captures a single frame and
places it on the system clipboard. The format of the captured frame (size and color depth)
depends on the values of the rest of the properties TRUE - capture successful |
| ConnectVideo (DriverIndex) Boolean CHANGED in Ver. 1.2 |
Connects the instance of the @ctiVideo control to the video driver (video frame
grabber card, camera, etc.). This method should be called before any other method or
property (except the properties, defining the user interface of the control, which can be
called at any time). If successful, the method will update the values of all other
properties, containing information about video formatting and structure and will enable
the methods for capturing video data. Once the control is connected to the video driver,
no other application (including other instances of the control) can use the video capture
hardware until DisconnectVideo method is invoked. DriverIndex (Optional) - determines the ordinal index of the driver you want to connect to. It can be between 0 and (DriverCount -1). If DriverCount is 0, or if DriverIndex is bigger than (DriverCount -1), the method will return FALSE.. You can use DriverName() and DriverVersion() properties to get information about the corresponding capture device. If omited, defaults to 0. TRUE - connect successful |
| DisconnectVideo Boolean |
Disconnects the instance of
the @ctiVideo control to the video
driver (video frame grabber card, camera, etc.). This method should be called before
closing your application in order to free the system resources and allow other
applications (including other instances of the control) to use the video capture
hardware. If successful, the method will disable all other methods until ConnectVideo
method is invoked again. TRUE - disconnect successful |
| FrameByFrameCapture Boolean NEW in Ver. 1.3 |
Captures a single frame and
appends it to the file, specified in the AVIFile property. You have to
open the file in Frame-by-Frame mode, using the FrameByFrameOpen method
before executing this method or an error will occur. The format of the captured frame
(size and color depth) depends on the values of the rest of the properties TRUE -
capture successful |
| FrameByFrameClose Boolean NEW in Ver. 1.3 |
Closes the file, specified in
the AVIFile property, which have been opened in Frame-by-Frame mode,
using the FrameByFrameOpen method before that. TRUE - close
successful |
| FrameByFrameOpen Boolean NEW in Ver. 1.3 |
Opens the file, specified in
the AVIFile property in Frame-by-Frame mode. Any frames, contained in the
file will be erased and the recording will begin from frame #1. Warning: This method OVERWRITES any contents in the file, it doesn't open for appending! TRUE - open successful |
| GrabFrame stdPicture |
Grabs and returns a single
frame from the currently connected video source. Returns NULL in case of error |
| LoadPreset (ApplicationName,
PresetNumber) Boolean NEW in Ver. 1.3 |
Loads a preset video format,
which has been stored beforehand using the SavePreset method. See that
method for further details on presets. ApplicationName argument allows you to
specify your application name, so your setting will be retrieved from the proper pool of
settings. You can omit this parameter if your preset was saved into the common pool. This
argument should have the same value that was used in the SavePreset
method when the selected preset was stored. PresetNumber argument allows you to
specify the preset position (0-9) you want to load. Warning: The method will load the pre-stored video format. In order to select interactively what the format is, you still need to invoke the ShowFormatDialog method. TRUE - load successful |
| SavePreset (ApplicationName,
PresetNumber) Boolean NEW in Ver. 1.3 |
Saves the current video format
into one of 10 presets, which can be used later by the LoadPreset method
to restore it. You can use these two methods to provide shortcuts for quick formating of
the video (resolution/color depth), to have several modes of operation of the frame
capture device without depending on user actions (you might want to set automatically High
resolution for still shots and lower resolution for motion video) or to ensure that your
software always works with the same video setting, no matter what the default settings of
the hardware are. ApplicationName argument allows you to specify your application
name, so your setting will not overwrite the settings of another application, running on
the same mashine and using this ActiveX control. You can omit this parameter and your
preset will be saved into the common pool. PresetNumber argument allows you to
specify the preset position (0-9) you want to use for storing the current settings. You
can consider this argument as the TV chanels on your TV set remote control. Warning: The method will save the CURRENT video format. In order to select interactively what the format is, you still need to invoke the ShowFormatDialog method. TRUE - save successful |
| ShowCompressionDialog Boolean |
Displays a dialog box in which
the user can select a compressor to use during the capture process. The list of available
compressors can vary with the video format selected in the capture driver's Video Format
dialog box. TRUE - Success |
| ShowDisplayDialog Boolean |
Displays a dialog box in which
the user can set or adjust the video output. This dialog box might contain controls that
affect the hue, contrast, and brightness of the displayed image, as well as key color
alignment. Available only if DriverHasDlgVideoDisplay property is TRUE. TRUE
- Success |
| ShowFormatDialog Boolean |
Displays a dialog box in which
the user can select the video format. The Video Format dialog box might be used to select
image dimensions, bit depth, and hardware compression options. Available only if DriverHasDlgVideoFormat
property is TRUE. TRUE - Success |
| ShowSourceDialog Boolean |
Displays a dialog box in which
the user can control the video source. The Video Source dialog box might contain controls
that select input sources; alter the hue, contrast, brightness of the image; and modify
the video quality before digitizing the images into the frame buffer. Available only if DriverHasDlgVideoSource
property is TRUE. TRUE - Success |
| StopAVICapture Boolean NEW in Ver. 1.3 |
Stops programatically the
capture process, initiated with the CaptureAVI method. Depending on the
settings of AbortLeftMouse and AbortRightMouse
properties, the capture process can be stopped by the user by clicking the corresponding
mouse button or by hitting any key on the keyboard. If you want to initiate this method
from a button or another inteface element, don't forget to set the AbortLeftMouse
property to false. TRUE - stop successful |
| Events | |
| Current version of @ctiVideo doesn't raise any events. | |